Sprite 1984

home *** CD-ROM | disk | FTP | other *** search

/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds.fmt / tx.man < prev next >

Wrap

Text File | 1990-08-16 | 26.2 KB | 663 lines

TX User Commands TX _________________________________________________________________ NNAAMMEE tx - Scrollable terminal emulator for X SSYYNNOOPPSSIISS ttxx [_o_p_t_i_o_n_s] OOPPTTIIOONNSS --bbdd _c_o_l_o_r Use _c_o_l_o_r as the border color for the window. If this switch isn't given then the bboorrddeerr-- CCoolloorr X default is used. If it isn't given either, then the foreground color is used. --bbgg _c_o_l_o_r Use _c_o_l_o_r as the background color for the window. If this switch isn't given then the bbaacckkggrroouunndd X default is used. If it isn't given either, or if the display is a black- and-white one, then White is used. --DD Causes ttxx not to detach itself from its | parent process. | --ddiissppllaayy _h_o_s_t::_d_i_s_p_l_a_y || Use _h_o_s_t and _d_i_s_p_l_a_y as an indication of the | display on which to open the window. The | display defaults to the one specified in the | DDIISSPPLLAAYY environment variable. --ffgg _c_o_l_o_r Use _c_o_l_o_r as the foreground color for the window. If this switch isn't given then the ffoorreeggrroouunndd X default is used. If it isn't given either, or if the display is a black- and-white one, then Black is used. --ffnn _f_o_n_t Use _f_o_n_t as the font for the window. If this switch isn't given, then the ffoonntt X default is used as the font. If it isn't given either, then the Sx default font is used. --ggeeoommeettrryy _g_e_o_m_e_t_r_y Use _g_e_o_m_e_t_r_y as the geometry for the window. | If no geometry is specified on the command | line, it the geometry defaults to the value | of the ggeeoommeettrryy X default. If no default is | specified, then ttxx picks a geometry. | --hheellpp || Print out a list of the command-line options | (and brief descriptions of their functions) | and exit without opening a window. Sprite v.1.0 Printed: August 15, 1990 1 TX User Commands TX --iiccoonn _f_i_l_e _F_i_l_e is the name of a file in bitmap format. Read the file and use it as the icon for the window. If _f_i_l_e is llooccaallhhoosstt, then ttxx chooses the default icon file corresponding to the local host. --iixx _x_c_o_o_r_d Display the icon at x-coordinate _x_c_o_o_r_d. --iiyy _y_c_o_o_r_d Display the icon at y-coordinate _y_c_o_o_r_d. --ssbb _c_o_l_o_r Use _c_o_l_o_r as the background color for the window's scrollbar. If this switch isn't given then the ssccrroollllbbaarr..bbaacckkggrroouunndd X default is used. If it isn't given either, then the background color for the text window is used. --ssee _c_o_l_o_r Use _c_o_l_o_r as the color for the window's scrollbar elevator. If this switch isn't given then the ssccrroollllbbaarr..eelleevvaattoorr X default is used. If it isn't given either, then the background color for the text window is used. --ssff _c_o_l_o_r Use _c_o_l_o_r as the foreground color for the window's scrollbar. If this switch isn't given then the ssccrroollllbbaarr..ffoorreeggrroouunndd X default is used. If it isn't given either, then the foreground color for the text window is used. --sshhoowwttiittllee Display a title bar at the top of the window. | Tx normally assumes that a window manager | will display a title bar; if your window | manager doesn't, you may wish to use this | switch. If this switch isn't specified, then | Tx checks for a sshhoowwTTiittllee X default; if it | exists and contains the string ``yes'', then | a title bar will be displayed. --ttbb _c_o_l_o_r Use _c_o_l_o_r as the background color for the window's title bar. If this switch isn't given then the ttiittllee..bbaacckkggrroouunndd X default is used. If it isn't given either, then the background color for the text window is used. This option is ignored if Tx isn't displaying a title bar. --ttff _c_o_l_o_r Use _c_o_l_o_r as the foreground color for the window's title bar. If this switch isn't given then the ttiittllee..ffoorreeggrroouunndd X default is used. If it isn't given either, then the foreground color for the text window is used. This option is ignored if Tx isn't displaying a title bar. Sprite v.1.0 Printed: August 15, 1990 2 TX User Commands TX --ttss _c_o_l_o_r Use _c_o_l_o_r as the color for the window's title stripes. If this switch isn't given then the itle.stripe X default is used. If it isn't given either, then the foreground color for the text window is used. This option is ignored if Tx isn't displaying a title bar. --ttiittllee _n_a_m_e Display _n_a_m_e in the title bar for the window. The default title is the name of the pseudo- terminal associated with the window. ==_g_e_o_m_e_t_r_y Use _g_e_o_m_e_t_r_y as the geometry specifier for the window (same effect as the --ggeeoommeettrryy ooppttiioonn)).. _h_o_s_t:_d_i_s_p_l_a_y Use this argument to select the display on which to create the window (same effect as the --ddiissppllaayy option). --ee _c_o_m_m_a_n_d This switch must be the last one, if it is present. The arguments following the --ee switch constitute the command to execute in the window. _C_o_m_m_a_n_d is run using the termi- nal emulator for standard input and standard output. When the command completes, the win- dow will be destroyed and ttxx will exit. The default command is ``/bin/csh -i'', or if a SHELL environment variable is defined, then it is invoked with a -i argument. _________________________________________________________________ IINNTTRROODDUUCCTTIIOONN TTxx is a terminal emulator that uses the facilities of the X window system, the Sx supplementary library, and the Tcl command interpreter. It executes a command (usually a shell) and arranges for the command's standard input and standard output streams to be directed from/to a pseudo- terminal controlled by ttxx. TTxx, in turn, displays a scroll- able window in more-or-less the same way as mmxx; output from the application is displayed in the window and keystrokes typed in the window are passed through to the application. TTxx windows emulate a very simple terminal with enough facil- ities to run programs like vi. The implementation of ttxx is very similar to that of mmxx; it shares much of the code and many of the commands. You should read the mmxx manual page before reading this one, in order to learn about the basic command interface and the mmxx commands. TTxx commands that are identical to mmxx commands are not documented here except by reference to the mmxx manual page. Sprite v.1.0 Printed: August 15, 1990 3 TX User Commands TX ..TTXX FFIILLEESS After processing command line options and opening the win- dow, ttxx checks for the existence of a file ``.tx'' in your home directory (environment variable HOME). If the file exists, ttxx reads it in and processes it as a command file, just as if it were read with the ssoouurrccee command. Then it checks for a .tx file in the current directory, and processes it if it exists. SSEELLEECCTTIIOONN Selection in ttxx is identical to that in mmxx, except for one difference. In ttxx the caret always appears at the end of the typescript, except when the typescript is in vi mode (see the vvii command); there is no way to reposition the caret with the mouse. VVAARRIIAABBLLEESS See the mmxx manual page for overall information. The special variables defined by ttxx are: aarrggss Set by ttxx to hold the arguments to the current variable being executed, if any. hheeiigghhtt Set by ttxx to hold the height of the window, in lines of text. If the last line appearing in the window is only partially visible, it doesn't count. sseeaarrcchhCCmmdd When the middle button is clicked in the ``Search'' string entry, or when carriage-return is typed there, the contents of this variable are executed as a command. sseeaarrcchhSSttrriinngg Set by ttxx to hold the contents of the search entry subwindow. tteerrmmccaapp Set by ttxx to hold a termcap entry that provides enough functionality to run Vi and other prehis- toric screen-based programs. It's based on a ter- minal type ``tx''. This variable is automatically reset whenever the window changes size. vveerrssiioonn Set by ttxx to hold a version number in the form | _x._y, where changes in _x correspond to major revi- | sions with probable incompatibilities, and changes | Sprite v.1.0 Printed: August 15, 1990 4 TX User Commands TX in _y represent small bug fixes and upgrades that | should not cause substantial compatibility prob- | lems. wwiiddtthh Set by ttxx to hold the width of the window, in characters. If the last character position is only partially-visible, then it doesn't count. If a variable-width font is being used, the average character size is used in computing the window's width. wwiinnddoowwIIdd Set by ttxx to hold the X window identifier for this window. MMAARRKKSS See the mmxx manual page for documentation. The same special marks are defined in ttxx as in mmxx. CCOOMMMMAANNDDSS TTxx is based around the Tcl interpreter just as mmxx is. Each keystroke or menu selection is bound to a Tcl command string, which is passed to the Tcl interpreter for execu- tion. See the Tcl man page for details on the built-in com- mands provided by Tcl. In addition to them, ttxx provides the following additional built-in commands. Many of them are identical to the corresponding commands in mmxx. bbiinndd [_s_e_q_u_e_n_c_e [_c_o_m_m_a_n_d]] Same as in mmxx. ccaarreett _o_p_e_r_a_n_d Same as in mmxx. ccoonnttrrooll _o_p_t_i_o_n _s_t_r_i_n_g Same as in mmxx. | ddeelleettee _m_a_r_k_1 [_m_a_r_k_2] Same as in mmxx. eessccaappee _o_p_t_i_o_n If _o_p_t_i_o_n is oonn, this command enables escape sequences in window output: whenever ttxx finds an escape charac- ter (338) in the stream of characters output to the pseudo-device for display in the window, it discards the escape sequence and interprets the following char- acters (up to and including the next newline character) as a ttxx command rather than characters to be displayed in the window. If _o_p_t_i_o_n is ooffff, escape sequences are Sprite v.1.0 Printed: August 15, 1990 5 TX User Commands TX disabled: they will be output to the window just like any other characters. Escape sequences are enabled by default in ttxx, and must be enabled for the TERMCAP mechanisms to work. This command is most useful to temporarily disable escape-processing while running programs that generate meaningless escape sequences. eexxttrraacctt _m_a_r_k_1 [_m_a_r_k_2] Same as in mmxx. ffooccuuss _w_i_n_d_o_w [cclleeaarr] Same as in mmxx. ggeeoommeettrryy _s_p_e_c Same as in mmxx. iinnsseerrtt _b_y_t_e_s _b_y_t_e_s ... Send _b_y_t_e_s to the application as keyboard input on the pty. If more than one _b_y_t_e_s argument is supplied, each is input in turn, with a single space between them. mmaarrkk _s_r_c _o_p _a_r_g_s Same as in mmxx. mmeennuu _o_p_t_i_o_n _a_r_g_s Same as in mmxx. mmeessssaaggee _s_t_r_i_n_g Same as in mmxx. mmxxooppeenn [_o_p_t_i_o_n_s] _f_i_l_e _f_i_l_e ... Same as ooppeenn command in in mmxx. Used to create an mmxx | window from ttxx, e.g. to display variable values. | mmxxsseenndd _w_i_n_d_o_w _c_o_m_m_a_n_d || Same as in sseenndd command in mmxx. Used to send commands | to mmxx windows created from ttxx. ooppeenn [_o_p_t_i_o_n_s] Open a new ttxx window. The _o_p_t_i_o_n_s to this command are | exactly the same as the command-line options for the ttxx | program, with the following exceptions. If the --ee | switch is given, then a new typescript is created and | all the remaining arguments to ooppeenn are used as a com- | mand name and arguments for the top-level application | in the new typescript. If the --ee option is not given, | then the new window will provide an alternate view on | the same typescript as the invoking window. The --DD | option is not permitted, nor are options that specify a | display. If no geometry specification is given in | _o_p_t_i_o_n_s, then ttxx uses the contents of the global vari- | able ggeeoommeettrryy as a default geometry; if no ggeeoommeettrryy | Sprite v.1.0 Printed: August 15, 1990 6 TX User Commands TX variable exists, then ttxx picks a default geometry. | Other options, such as foreground color and font, | default to the values from the invoking window, rather | than looking for X defaults. OOppeenn sets the global variable nneewwWWiinnddooww to hold the id of the newly-created window. This may be used in conjunction with the sseenndd command to issue commands to the new window. The return value is always an empty string. oouuttppuutt _b_y_t_e_s Insert _b_y_t_e_s in the output display as if they had been output by the application. qquuiitt Destroy the ttxx window and end the program. qquuoottee Same as in mmxx. | sseeaarrcchh [_d_i_r_e_c_t_i_o_n [_p_a_t_t_e_r_n]] Same as in mmxx. sseeee _m_a_r_k [[ttoopp|cceenntteerr|bboottttoomm] Same as in mmxx. sseelleeccttiioonn _o_p_t_i_o_n [_a_r_g ...] Same as in mmxx. sseenndd _w_i_n_d_o_w _c_o_m_m_a_n_d Same as in mmxx. ttiittllee _l_e_f_t _c_e_n_t_e_r _r_i_g_h_t _w_m_N_a_m_e Change the title information for the window. _L_e_f_t will | be displayed at the left side of the title bar, _c_e_n_t_e_r | in the middle of the bar, and _r_i_g_h_t at the right side | of the title bar. If any of these three arguments is | an empty string, then nothing will be displayed in the | corresponding position. The string given by _w_m_N_a_m_e | will be recorded as the window's name for the window | manager. This name will probably appear when the win- | dow is iconified, for example. If Tx isn't displaying | a title for the window, then only the _w_m_N_a_m_e argument | will be used. uuppddaattee Same as in mmxx. vvii _o_p_t_i_o_n _a_r_g_s This command provides an alternate mode of operation, called ``vi mode'', which provides sufficient terminal emulation to run the vi editor. When the window is in vi mode, an additional window-full of blank lines (called the _v_i _a_r_e_a) is added at the beginning (top) of Sprite v.1.0 Printed: August 15, 1990 7 TX User Commands TX the typescript, and the view is shifted to display those lines. Most of the vvii commands are used only in the crude termcap entry that ttxx provides for itself. The vvii command must have one of the following forms: vvii eenntteerr Enter vi mode. Fill the vi area with blank lines, change the window's view to display those lines, and move the caret to position 0.0. vvii lleeaavvee Leave vi mode. Delete the lines in the vi area, move the caret back to the end of the typescript, and change the window's view to display the end of the typescript. vvii ccdd Clear all the lines on the screen at or below the caret position, leaving the caret at the beginning of its (now-blank) line. This command is provided primarily for emulating the ccdd termcap entry. vvii ccee Clear from the caret position to the end of the line, leaving the caret where it is. This command is provided primarily for emulating the ccee termcap entry. vvii cclleeaarr Clear the lines in the vi area and move the caret to the home position (0.0). vvii ccuurrssoorr _l_i_n_e_I_n_d_e_x _c_h_a_r_I_n_d_e_x Set the caret position to line _l_i_n_e_I_n_d_e_x, charac- ter _c_h_a_r_I_n_d_e_x. This position must lie within the via area. vvii ddeelleetteelliinnee Delete the line containing the caret, and add a new line to the bottom of the vi area to keep the total number of lines in the via area constant. vvii iinnsseerrttlliinnee Add a new blank line to the vi area, just before the caret (the caret should be at the beginning of a line). Delete the last line in the vi area, in order to keep the total number of lines in the vi area constant. vvii oonn Returns a non-zero string if the window is currently in vi mode, and a zero string otherwise. Sprite v.1.0 Printed: August 15, 1990 8 TX User Commands TX vvii ttaabb Move the caret to the next tab stop. vvii uupp Move the caret up one line. vvii vvtt110000 _m_o_d_e If mode is nonzero, tx enters vt100 emulation | mode. If mode is zero, tx exits vt100 emulation | mode. Not all vt100 functions are emulated. CCOOMMMMAANNDD PPRROOCCEEDDUURREESS In addition to the built-in commands described above, a | number of Tcl command procedures are created by the default | ttxx startup file. They may be invoked just like built-in | commands, and are described below. | sshhoowwBBiinnddiinnggss _b_i_n_d_i_n_g _b_i_n_d_i_n_g ... || Same as in mmxx. | sshhoowwMMeennuuss _n_a_m_e _n_a_m_e ... || Same as in mmxx. | sshhoowwPPrrooccss _n_a_m_e _n_a_m_e ... || Same as in mmxx. | sshhoowwVVaarrss _n_a_m_e _n_a_m_e ... || Same as in mmxx. | wwhheerree || Same as in mmxx. TTEERRMMCCAAPP IINNFFOORRMMAATTIIOONN TTxx stores an up-to-date termcap entry in the tteerrmmccaapp vari- able, and initializes the TERM and TERMCAP environment vari- ables when it starts up, so that you can run programs that use termcap information. If you change the size of a ttxx window, ttxx will update the tteerrmmccaapp variable and invoke the TIOCSWINSZ ioctl to notify the application, but it cannot update the TERM and TERMCAP environment variables in the application; you can use the ``Set Termcap'' menu entry to invoke shell commands to update TERM and TERMCAP. If you use ttxx to rlogin to a different machine, most machines have never heard of ttxx so they don't have entries for it in their /etc/termcap files. There are two possible solutions to this problem: a) you can invoke the ``Set Termcap'' menu entry after you've gotten logged in to the remote machine; b) you can use the _t_x_i_n_f_o program as part of your .login shell script, in order to set up the TERMCAP automatically. See the manual page for _t_x_i_n_f_o for details. Sprite v.1.0 Printed: August 15, 1990 9 TX User Commands TX CCOOMMMMAANNDD SSUUBBWWIINNDDOOWW Same as in mmxx. MMUULLTTIIPPLLEE WWIINNDDOOWWSS OONN SSAAMMEE TTYYPPEESSCCRRIIPPTT The ooppeenn command may be used to open several windows on the same typescript. The windows behave identically except for one thing: window size. There is a single window size asso- ciated with the typescript, which is returned when applica- tions perform TIOCGWINSZ ioctl operations on the pseudo- terminal. If the different windows have different sizes, then Tx always uses the size from a particular one of the windows (usually the first window created on the typescript). The other windows are labelled AAlltteerrnnaattee at the right side of their title bars to indicate that their sizes will not be reflected to the application. SSEEEE AALLSSOO mx, txcmd, txinfo KKEEYYWWOORRDDSS mouse, terminal emulator, typescript, window Sprite v.1.0 Printed: August 15, 1990 10